Skip to main content
Version: current

Scheduled Webinar - Create a scheduled webinar​

This API creates a scheduled webinar. Webinar validity is maintained until the host establishes the start time and end time parameters.

Header Parameters
    Content-Type string

    The content type should be application/json

    Example: application/json
    Authorization string required

    You need an app created on the JioEvents Platform and using the app credentials you can create a JWT to access this API. The JWT should have an issuer and the key "app" with the app id generated from the Platform.

    Example: <Authentication_token_signed_using_secret_or_private_key>
Request Body
    topic string

    The topic of the webinar

    startTime string

    The start time of the webinar in ISO format

    endTime string

    The end time of the webinar in ISO format

    webinar object

    Webinar configuration

    enabled boolean

    Whether the webinar feature is enabled

Responses

Success

Schema
    jiomeetId string

    The 10 digit unique ID of the webinar

    topic string

    The topic/title of the webinar

    startTime date-time

    The start time of the webinar in ISO format

    endTime date-time

    The end time of the webinar in ISO format

    scheduledDuration number

    The duration of the webinar in milliseconds

    meetingUrl string

    The meeting URL that users will use to join the webinar

    speakerLink string

    The speaker link for the webinar

    attendeeLink string

    The attendee link for the webinar

    webinar object

    Webinar-specific configuration and activation details

    enabled boolean

    Whether the webinar feature is enabled

    options object

    Webinar options configuration

    quesAns boolean

    Whether Q&A is enabled

    allowGuests boolean

    Whether guests are allowed

    comments boolean

    Whether comments are enabled

    ticker object

    Ticker configuration

    enabled boolean

    Whether ticker is enabled

    text string

    Ticker text

    thankYouMsg object

    Thank you message configuration

    enabled boolean

    Whether thank you message is enabled

    text string

    Thank you message text

    views object

    Views configuration

    showCount boolean

    Whether to show view count

    likes object

    Likes and reactions configuration

    showCount boolean

    Whether to show like count

    floatingReactions object

    Floating reactions configuration

    enabled boolean

    Whether floating reactions are enabled

    reactionType string[]

    Available reaction types

    enabled boolean

    Whether likes are enabled

    videoQuality string

    Video quality setting

    customization object

    Customization options

    hideCompletedSessions boolean

    Whether to hide completed sessions

    enableHandRaise boolean

    Whether hand raise is enabled

    hideWelcomeMessage boolean

    Whether to hide welcome message

    equalTileLayout boolean

    Whether to use equal tile layout

    shouldSendSMSToAttendee boolean

    Whether to send SMS to attendee

    practiceSession boolean

    Whether practice session is enabled

    onDemand boolean

    Whether on-demand is enabled

    record boolean

    Whether recording is enabled

    flashcard boolean

    Whether flashcard is enabled

    feedLayout string

    Feed layout type

    registration object

    Registration configuration

    enabled boolean

    Whether registration is enabled

    enabledFullName boolean

    Whether full name is enabled for registration

    autoApprove boolean

    Whether auto approval is enabled

    otpEnabled boolean

    Whether OTP is enabled

    inviteOnly boolean

    Whether invite only is enabled

    openInvite boolean

    Whether open invite is enabled

    closeBeforeDays integer

    Days before which registration closes

    recording object

    Recording configuration

    recordingType string

    Type of recording

    attendeeFeed string

    Attendee feed type

    activation object

    Activation details for the webinar

    hash string

    Unique hash for webinar activation

    url string

    Activation URL for the webinar

    attendeeWebsocketEnabled boolean

    Whether attendee websocket is enabled

    broadcasting boolean

    Whether broadcasting is enabled

    qnaTimeLimit integer

    Q&A time limit in minutes

    webinarPortal object

    Webinar portal configuration

    enabled boolean

    Whether webinar portal is enabled

    sessions object

    Sessions configuration

    enabled boolean

    Whether sessions are enabled

    registrationEnabled boolean

    Whether session registration is enabled

    networking object

    Networking configuration

    enabled boolean

    Whether networking is enabled

    availability string

    Networking availability

    leaderboard object

    Leaderboard configuration

    enabled boolean

    Whether leaderboard is enabled

    preRecordedVideo object

    Pre-recorded video configuration

    enabled boolean

    Whether pre-recorded video is enabled

    loop integer

    Number of loops for pre-recorded video

    advancedOptions object

    Advanced configuration options for the webinar

    joinBeforeHost boolean

    Whether participants can join before the host

    loggedInOnly boolean

    Whether only logged-in users can join

    status string

    The current status of the webinar

    roomPIN string

    Meeting PIN that secures the webinar from unwanted access

    meetingId string

    The meeting ID that can be used to update, delete or fetch this webinar

Loading...